/* *****************************************************************************
 * JFab (http://code.google.com/p/jfab)
 * Copyright (c) 2011 JFab.org
 * Admin jfab@jeffreythompson.net
 *
 * See the file "LICENSE.txt" for information on usage and redistribution of
 * this file, and for a DISCLAIMER OF ALL WARRANTIES.
 * *****************************************************************************/

package org.jfab.core.factory;

import java.util.List;

import org.jfab.core.collection.CGAnnotationList;
import org.jfab.core.collection.CGFieldList;
import org.jfab.core.collection.CGMethodDeclarationList;
import org.jfab.core.collection.CGTypeList;
import org.jfab.core.collection.CommentList;
import org.jfab.core.collection.ModifierList;
import org.jfab.core.model.CGInterface;

/**
 * Defines methods required by a code generator interface factory.
 */
public interface CGInterfaceFactory
{
    /**
     * @param referencedTypes Referenced types.
     * @param packageName Package name.
     * @param commentLines Comment lines.
     * @param annotations Annotations.
     * @param modifiers Modifiers.
     * @param interfaceName Interface name. (required)
     * @param typeParameters Type parameters.
     * @param extendsTypes Extends types.
     * @param fields Fields.
     * @param methods Methods.
     * 
     * @return a new code generator interface.
     */
    CGInterface createInterface(CGTypeList referencedTypes, String packageName,
            CommentList commentLines, CGAnnotationList annotations,
            ModifierList modifiers, String interfaceName,
            List<String> typeParameters, CGTypeList extendsTypes,
            CGFieldList fields, CGMethodDeclarationList methods);
}
